Skip to content

docs: add versioning with mike#203

Merged
michalsn merged 1 commit into
codeigniter4:developfrom
michalsn:feat/docs-versioning
Jun 5, 2026
Merged

docs: add versioning with mike#203
michalsn merged 1 commit into
codeigniter4:developfrom
michalsn:feat/docs-versioning

Conversation

@michalsn

@michalsn michalsn commented Jun 5, 2026

Copy link
Copy Markdown
Member

Description
This PR adds docs versioning using mike, published to the gh-pages branch.

Deploy rules

  • Push to develop: deploys the dev docs (work-in-progress)
  • Push a vX.Y.Z tag (e.g. v1.1.0): deploys docs under <major>.<minor> (e.g. 1.1), updates the latest alias, and sets it as the default version (site root redirects here)
  • Pre-release tags (e.g. v1.1.0-rc1): are skipped

Checklist:

  • Securely signed commits
  • Component(s) with PHPDoc blocks, only if necessary or adds value
  • Unit testing, with >80% coverage
  • User guide updated
  • Conforms to style guide

@michalsn michalsn added the github_actions Pull requests that update Github_actions code label Jun 5, 2026

@paulbalandan paulbalandan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of deploying from a branch, how about deploying from a folder in the default branch?

@michalsn

michalsn commented Jun 5, 2026

Copy link
Copy Markdown
Member Author

If I understand you correctly, then no. Pages can't serve an arbitrary folder (only / or /docs), and it's incompatible with mike branch-based versioning anyway.

@paulbalandan

Copy link
Copy Markdown
Member

Pages can deploy from a folder, like /docs. However, since you said mike deploys from a branch, then all good.

@michalsn michalsn merged commit a485dc7 into codeigniter4:develop Jun 5, 2026
1 check passed
@michalsn

michalsn commented Jun 5, 2026

Copy link
Copy Markdown
Member Author

Thank you @paulbalandan

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

github_actions Pull requests that update Github_actions code

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants